package loggerhelper

Import Path
	github.com/Golang-Tools/loggerhelper (on go.dev)

Dependency Relation
	imports 4 packages, and imported by one package

Involved Source Files

	      loggerhelper.go
	      options.go
Package-Level Type Names (total 5, in which 4 are exported)

	/* sort exporteds by: alphabet | popularity */
	 type Dict (map)
		Dict 简化键值对的写法

	 type FormatType int32 (basic type)
		redis类型

		As Types Of (total 2, both are exported)
			const FormatType_JSON
			const FormatType_Text

	 type Option (interface)
		Option configures how we set up the connection.

		Methods (only one, which is exported)
			( T) Apply(*Options)
		Implemented By (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			*funcOption
		As Outputs Of (at least 9, all are exported)
			func AddExtField(field string, value interface{}) Option
			func AddHooks(hooks ...logrus.Hook) Option
			func WithDefaultFieldMap(fm logrus.FieldMap) Option
			func WithDisableTimeField() Option
			func WithExtFields(extFields map[string]interface{}) Option
			func WithLevel(loglevel string) Option
			func WithOutput(writer io.Writer) Option
			func WithTextFormat() Option
			func WithTimeFormat(TimeFormat string) Option
		As Inputs Of (at least one exported)
			func Init(opts ...Option)

	 type Options (struct)
		Option 设置key行为的选项
		@attribute MaxTTL time.Duration 为0则不设置过期
		@attribute AutoRefresh string 需要为crontab格式的字符串,否则不会自动定时刷新

		Fields (total 8, all are exported)
			DefaultFieldMap logrus.FieldMap
			DisableTimeField bool
			ExtFields map[string]interface{}
			Hooks []logrus.Hook
			Level logrus.Level
			Output io.Writer
			TimeFormat string
			Type FormatType
		As Inputs Of (at least one exported)
			func Option.Apply(*Options)
		As Types Of (only one, which is exported)
			  var DefaultOpts

	/* one unexported ... *//* one unexported: */
	 type funcOption (struct)
		func (emptyOption) apply(*Options) {}

		Fields (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			f func(*Options)
		Methods (only one, which is exported)
			(*T) Apply(do *Options)
		Implements (at least one exported)
			*T : Option
		As Outputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func newFuncOption(f func(*Options)) *funcOption


Package-Level Functions (total 20, in which 18 are exported)

	 func AddExtField(field string, value interface{}) Option
		AddExtField Init函数的参数,用于增加扩展字段

	 func AddHooks(hooks ...logrus.Hook) Option
		AddHooks Init函数的参数,用于增加钩子

	 func Debug(message string, fields ...map[string]interface{})
		Debug 默认log打印Debug级别信息
		@params message string 事件消息
		@params fields ...map[string]interface{} 信息字段

	 func Error(message string, fields ...map[string]interface{})
		Error 默认log打印Error级别信息
		@params message string 事件消息
		@params fields ...map[string]interface{} 信息字段

	 func Fatal(message string, fields ...map[string]interface{})
		Fatal 默认log打印Fatal级别信息
		@params message string 事件消息
		@params fields ...map[string]interface{} 信息字段

	 func Info(message string, fields ...map[string]interface{})
		Info 默认log打印Info级别信息
		@params message string 事件消息
		@params fields ...map[string]interface{} 信息字段

	 func Init(opts ...Option)
		Init 初始化默认的log对象
		@params opts ...Option 初始化使用的参数,具体可以看options.go文件

	 func New() *logrus.Logger
		New 初始化log的配置

	 func Panic(message string, fields ...map[string]interface{})
		Panic 默认log打印Panic级别信息
		@params message string 事件消息
		@params fields ...map[string]interface{} 信息字段

	 func Trace(message string, fields ...map[string]interface{})
		Trace 默认log打印Trace级别信息
		@params message string 事件消息
		@params fields ...map[string]interface{} 信息字段

	 func Warn(message string, fields ...map[string]interface{})
		Warn 默认log打印Warn级别信息
		@params message string 事件消息
		@params fields ...map[string]interface{} 信息字段

	 func WithDefaultFieldMap(fm logrus.FieldMap) Option
		WithDefaultFieldMap Init函数的参数,用于设置默认字段的新命名

	 func WithDisableTimeField() Option
		WithDisableTimeField Init函数的参数,用于设置使用text格式替换json格式

	 func WithExtFields(extFields map[string]interface{}) Option
		WithExtFields Init函数的参数,用于设置扩展字段

	 func WithLevel(loglevel string) Option
		WithLevel Init函数的参数,用于设置log等级

	 func WithOutput(writer io.Writer) Option
		WithOutput Init函数的参数,用于设置log的写入io

	 func WithTextFormat() Option
		WithTextFormat Init函数的参数,用于设置使用text格式替换json格式

	 func WithTimeFormat(TimeFormat string) Option
		WithTimeFormat Init函数的参数,用于设置使用指定的时间解析格式,默认为RFC3339Nano

	/* 2 unexporteds ... *//* 2 unexporteds: */
	 func newFuncOption(f func(*Options)) *funcOption
	 func parseLevel(loglevel string) logrus.Level
		parseLevel 将字符串转为`logrus.Level`,未知的字符串默认匹配为"logrus.DebugLevel"


Package-Level Variables (total 3, in which 2 are exported)

	  var DefaultOpts Options
	  var Logger *logrus.Logger
		Logger 默认的logger

	/* one unexported ... *//* one unexported: */
	  var defaultlog *logrus.Entry
		默认的Log对象


Package-Level Constants (total 2, both are exported)

	const FormatType_JSON FormatType = 0
	const FormatType_Text FormatType = 1

The pages are generated with Golds v0.3.6. (GOOS=darwin GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.